<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>headset.model.Model.HeaDSETModel</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="headset-module.html">Package&nbsp;headset</a> ::
        <a href="headset.model-module.html">Package&nbsp;model</a> ::
        <a href="headset.model.Model-module.html">Module&nbsp;Model</a> ::
        Class&nbsp;HeaDSETModel
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class HeaDSETModel</h1><p class="nomargin-top"><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel">source&nbsp;code</a></span></p>
<p>The HeaDSETModel is a wrapper for the collections of geoms. It handles
  these list genericly. And provides hooks for the VTK components for them 
  to maintain state. The model has two modes ModelMode and NonModelMode. In
  Model mode the system will not allow mutations to the tumor and safe path
  geoms.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      The constructor for the class initialises the standard lists and 
      individual geoms.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#__addGeom" class="summary-sig-name" onclick="show_private();">__addGeom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">list</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Private method to add a geom to a collection and to notify the view 
      that a geom has been added.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__addGeom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#__removeGeom" class="summary-sig-name" onclick="show_private();">__removeGeom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">list</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Private method to remove geom from a collection.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__removeGeom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#__changeColor" class="summary-sig-name" onclick="show_private();">__changeColor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">list</span>,
        <span class="summary-sig-arg">color</span>)</span><br />
      Private method that changes the color for an entire list at once.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__changeColor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#__changeVisible" class="summary-sig-name" onclick="show_private();">__changeVisible</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">list</span>,
        <span class="summary-sig-arg">visible</span>)</span><br />
      Private method that changes the visibility of the entire list at once
      to the user provided visiblity status.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__changeVisible">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#ModelMode" class="summary-sig-name">ModelMode</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Set the system in ModelMode.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.ModelMode">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#IsModelMode" class="summary-sig-name">IsModelMode</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Tells if the system is in ModelMode.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.IsModelMode">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#NonModelMode" class="summary-sig-name">NonModelMode</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Set the system in ModelMode.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.NonModelMode">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#IsNonModelMode" class="summary-sig-name">IsNonModelMode</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Tells if the system is in NonModelMode</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.IsNonModelMode">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#SetDicomModel" class="summary-sig-name">SetDicomModel</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Set the Dicom for the current session.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetDicomModel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetDicomModel" class="summary-sig-name">GetDicomModel</a>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetDicomModel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#UnsetDicomModel" class="summary-sig-name">UnsetDicomModel</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Removes the Dicom model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.UnsetDicomModel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#AddToPath" class="summary-sig-name">AddToPath</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Adds a geom to the path list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.AddToPath">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#RemoveFromPath" class="summary-sig-name">RemoveFromPath</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Removes a geom from the path list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.RemoveFromPath">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#AddToTumor" class="summary-sig-name">AddToTumor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Adds a geom to the tumor list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.AddToTumor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#RemoveFromTumor" class="summary-sig-name">RemoveFromTumor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Removes a geom from the tumor list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.RemoveFromTumor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetMutables" class="summary-sig-name">GetMutables</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns a list of geoms that the view is allowed to manipulate.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetMutables">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetInstrument" class="summary-sig-name">GetInstrument</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Gives back the instrument geom.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetInstrument">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetTumorGeom" class="summary-sig-name">GetTumorGeom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Gives back a tumor geom by index.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetTumorGeom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetPathGeom" class="summary-sig-name">GetPathGeom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Gives back a path geom by index.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetPathGeom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetNumberOfTumorGeoms" class="summary-sig-name">GetNumberOfTumorGeoms</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the number of geoms that are in the Tumor list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetNumberOfTumorGeoms">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetNumberOfPathGeoms" class="summary-sig-name">GetNumberOfPathGeoms</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the number of geoms that are in the Path list.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetNumberOfPathGeoms">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetGeomByID" class="summary-sig-name">GetGeomByID</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">ID</span>)</span><br />
      Gives back the geom by it's ID.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetGeomByID">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#RemoveGeom" class="summary-sig-name">RemoveGeom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Removes a mutable geom.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.RemoveGeom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#Clone" class="summary-sig-name">Clone</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Clones a geom</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.Clone">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#DisplayInstrument" class="summary-sig-name">DisplayInstrument</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Enables the instrument if not present, if the instrument is invisble 
      it is made visible again</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.DisplayInstrument">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#SetPathColor" class="summary-sig-name">SetPathColor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">red</span>,
        <span class="summary-sig-arg">green</span>,
        <span class="summary-sig-arg">blue</span>)</span><br />
      Changes the default path color</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetPathColor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#SetTumorColor" class="summary-sig-name">SetTumorColor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">red</span>,
        <span class="summary-sig-arg">green</span>,
        <span class="summary-sig-arg">blue</span>)</span><br />
      Changes the default Tumor color.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetTumorColor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#SetInstrumentColor" class="summary-sig-name">SetInstrumentColor</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">red</span>,
        <span class="summary-sig-arg">green</span>,
        <span class="summary-sig-arg">blue</span>)</span><br />
      Changes the default Instrument color.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetInstrumentColor">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#SetVisibleGroup" class="summary-sig-name">SetVisibleGroup</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">visible</span>)</span><br />
      Changes the visibility of an entire collection at once.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetVisibleGroup">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#IsTumorGeom" class="summary-sig-name">IsTumorGeom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Checks if the given geom is a tumor geom.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.IsTumorGeom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#IsPathGeom" class="summary-sig-name">IsPathGeom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">geom</span>)</span><br />
      Checks if the given geom is a path geom.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.IsPathGeom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#Save" class="summary-sig-name">Save</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Save state to xml.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.Save">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#Load" class="summary-sig-name">Load</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">XML</span>)</span><br />
      Load geoms from an xml string as created by self.Save</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.Load">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#_LoadGeom" class="summary-sig-name" onclick="show_private();">_LoadGeom</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">elem</span>,
        <span class="summary-sig-arg">addFunction</span>)</span><br />
      Creates a geom from the attributes described by elem, and call the 
      method addFunction(newGeom).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel._LoadGeom">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#Reset" class="summary-sig-name">Reset</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Resets the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.Reset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#AddRecording" class="summary-sig-name">AddRecording</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">recording</span>)</span><br />
      Adds a recording to the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.AddRecording">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetRecording" class="summary-sig-name">GetRecording</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Returns the recording belonging to a certain index.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetRecording">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.model.Model.HeaDSETModel-class.html#GetNumberOfRecordings" class="summary-sig-name">GetNumberOfRecordings</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the numbger of recordings in the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetNumberOfRecordings">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="headset.model.Model.HeaDSETModel-class.html#TUMOR" class="summary-name">TUMOR</a> = <code title="'Tumor'"><code class="variable-quote">'</code><code class="variable-string">Tumor</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="headset.model.Model.HeaDSETModel-class.html#PATH" class="summary-name">PATH</a> = <code title="'Safe path'"><code class="variable-quote">'</code><code class="variable-string">Safe path</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="headset.model.Model.HeaDSETModel-class.html#PATH_SAVE" class="summary-name">PATH_SAVE</a> = <code title="'Safe_path'"><code class="variable-quote">'</code><code class="variable-string">Safe_path</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>The constructor for the class initialises the standard lists and 
  individual geoms. It also defines te standard colors for the different 
  geom collections</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="__addGeom"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__addGeom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">list</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__addGeom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Private method to add a geom to a collection and to notify the view 
  that a geom has been added.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>list</code></strong> - The internal collection that will be modified.</li>
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be added to the specified list.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="__removeGeom"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__removeGeom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">list</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__removeGeom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Private method to remove geom from a collection. The function also 
  notifies the view of the removal of the geom.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>list</code></strong> - The internal collection that will be modified.</li>
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be removed from the specified list.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="__changeColor"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__changeColor</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">list</span>,
        <span class="sig-arg">color</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__changeColor">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Private method that changes the color for an entire list at once. Will
  once change the color of the currently active geoms in the view.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>list</code></strong> - The internal collection that will be modified.</li>
        <li><strong class="pname"><code>color</code></strong> - The color used for this entire collection</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="__changeVisible"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__changeVisible</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">list</span>,
        <span class="sig-arg">visible</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.__changeVisible">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Private method that changes the visibility of the entire list at once 
  to the user provided visiblity status.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>list</code></strong> - The internal collection that will be modified.</li>
        <li><strong class="pname"><code>visible</code></strong> - The color used for this entire collection</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="ModelMode"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ModelMode</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.ModelMode">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set the system in ModelMode. This means that the system allows changes
  to tumor and safe path geoms by the view.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="IsModelMode"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">IsModelMode</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.IsModelMode">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Tells if the system is in ModelMode.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>True if the moel is in ModelMode. False if the system is not in 
          ModelMode.</dd>
  </dl>
</td></tr></table>
</div>
<a name="NonModelMode"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">NonModelMode</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.NonModelMode">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set the system in ModelMode. This means that the system does not allow
  changes to tumor and safe path geoms by the view.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="IsNonModelMode"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">IsNonModelMode</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.IsNonModelMode">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Tells if the system is in NonModelMode</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>True if the moel is in NonModelMode. False if the system is not 
          in NonModelMode.</dd>
  </dl>
</td></tr></table>
</div>
<a name="SetDicomModel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">SetDicomModel</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetDicomModel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set the Dicom for the current session.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom which will be considered a Dicom model.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="GetDicomModel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetDicomModel</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetDicomModel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="UnsetDicomModel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">UnsetDicomModel</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.UnsetDicomModel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes the Dicom model.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="AddToPath"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">AddToPath</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.AddToPath">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a geom to the path list.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be added to the path.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="RemoveFromPath"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">RemoveFromPath</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.RemoveFromPath">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes a geom from the path list.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be removed from the path list.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="AddToTumor"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">AddToTumor</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.AddToTumor">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a geom to the tumor list.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be added to the tumor list.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="RemoveFromTumor"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">RemoveFromTumor</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.RemoveFromTumor">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes a geom from the tumor list.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be removed from the the tumor list.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="GetMutables"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetMutables</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetMutables">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns a list of geoms that the view is allowed to manipulate.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>List of mutable geoms</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetInstrument"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetInstrument</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetInstrument">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gives back the instrument geom.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>The geom that is designated the instrument</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetTumorGeom"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetTumorGeom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetTumorGeom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gives back a tumor geom by index.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>index</code></strong> - The index of the geom in the list.</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>The requested geom</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetPathGeom"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetPathGeom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetPathGeom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gives back a path geom by index.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>index</code></strong> - The index of the geom in the list.</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>The requested geom.</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetNumberOfTumorGeoms"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetNumberOfTumorGeoms</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetNumberOfTumorGeoms">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of geoms that are in the Tumor list.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>The number of tumor geoms.</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetNumberOfPathGeoms"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetNumberOfPathGeoms</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetNumberOfPathGeoms">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of geoms that are in the Path list.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>The number of path geoms.</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetGeomByID"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetGeomByID</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">ID</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetGeomByID">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gives back the geom by it's ID.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>ID</code></strong> - The ID of the geom</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>The geom with the ID if in the system, if the geom is not the 
          system it will return None</dd>
  </dl>
</td></tr></table>
</div>
<a name="RemoveGeom"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">RemoveGeom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.RemoveGeom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes a mutable geom.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be removed.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="Clone"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Clone</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.Clone">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Clones a geom</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be cloned</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="DisplayInstrument"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">DisplayInstrument</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.DisplayInstrument">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Enables the instrument if not present, if the instrument is invisble 
  it is made visible again</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="SetPathColor"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">SetPathColor</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">red</span>,
        <span class="sig-arg">green</span>,
        <span class="sig-arg">blue</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetPathColor">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Changes the default path color</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>red</code></strong> - The new default red component</li>
        <li><strong class="pname"><code>green</code></strong> - The new default green component</li>
        <li><strong class="pname"><code>blue</code></strong> - The new default blue component</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="SetTumorColor"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">SetTumorColor</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">red</span>,
        <span class="sig-arg">green</span>,
        <span class="sig-arg">blue</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetTumorColor">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Changes the default Tumor color.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>red</code></strong> - The new default red component</li>
        <li><strong class="pname"><code>green</code></strong> - The new default green component</li>
        <li><strong class="pname"><code>blue</code></strong> - The new default blue component</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="SetInstrumentColor"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">SetInstrumentColor</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">red</span>,
        <span class="sig-arg">green</span>,
        <span class="sig-arg">blue</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetInstrumentColor">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Changes the default Instrument color.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>red</code></strong> - The new default red component</li>
        <li><strong class="pname"><code>green</code></strong> - The new default green component</li>
        <li><strong class="pname"><code>blue</code></strong> - The new default blue component</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="SetVisibleGroup"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">SetVisibleGroup</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">visible</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.SetVisibleGroup">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Changes the visibility of an entire collection at once. This is used 
  mainly in the operation view. The name argument is a string containing 
  the name of the collection that should be changed.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>name</code></strong> - The name of the collection.</li>
        <li><strong class="pname"><code>visible</code></strong> - The setting.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="IsTumorGeom"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">IsTumorGeom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.IsTumorGeom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if the given geom is a tumor geom.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be checked.</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>True if it's a tumor geom false if not.</dd>
  </dl>
</td></tr></table>
</div>
<a name="IsPathGeom"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">IsPathGeom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">geom</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.IsPathGeom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if the given geom is a path geom.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>geom</code></strong> - The geom that will be checked.</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>True if it's a path geom false if not.</dd>
  </dl>
</td></tr></table>
</div>
<a name="Save"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Save</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.Save">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Save state to xml. Save the al the attributes of all Geoms this model 
  contains to an XML file.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>A string containing the XML</dd>
  </dl>
</td></tr></table>
</div>
<a name="Load"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Load</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">XML</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.Load">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Load geoms from an xml string as created by self.Save</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>XML</code></strong> - xml string created by self.Save</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="_LoadGeom"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_LoadGeom</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">elem</span>,
        <span class="sig-arg">addFunction</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel._LoadGeom">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Creates a geom from the attributes described by elem, and call the 
  method addFunction(newGeom).</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>elem</code></strong> - DOM-element describing a geom.</li>
        <li><strong class="pname"><code>addFunction</code></strong> - function accepting the geom as a single parameter.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="Reset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Reset</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.Reset">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Resets the model. All geoms are removed and ID's are reset to 1.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="AddRecording"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">AddRecording</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">recording</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.AddRecording">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a recording to the model.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>recording</code></strong> - The recording to be stored.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="GetRecording"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetRecording</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetRecording">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the recording belonging to a certain index.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>index</code></strong> - The index of the requested recording.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="GetNumberOfRecordings"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetNumberOfRecordings</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.model.Model-pysrc.html#HeaDSETModel.GetNumberOfRecordings">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the numbger of recordings in the model.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>The number of geoms.</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variable Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariableDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="TUMOR"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">TUMOR</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">Tumor</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="PATH"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">PATH</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">Safe path</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="PATH_SAVE"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">PATH_SAVE</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">Safe_path</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    <a href="epydoc-log.html">Generated by Epydoc
    3.0.1 on Wed Feb 25 12:57:58 2009</a>
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
